// Written in the D Programming Language
/*
 * Copyright (c) 2008 OpenGLUtils
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'OpenGLUtils' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
module openglutils.GLObject;

import openglutils.GL;

/**
 * The OpenGL Object. This abstract class can be used as a base class for those OpenGL objects that use object ids.
 * For example textures and shaders.
 */
public abstract class GLObject 
{
    private GLuint id;

    /**
     * Constructs a new OpenGL Object. The implementing class will provide the id for this object.
     */
    public this() {
        id = generateID();
    }

    /**
     * Destructs the OpenGL Object. The implementing class will provide the way to properly destroy the OpenGL Object.
     */
    public ~this() {
        destroy();
    }

    /**
     * Gets the id for this object.
     * 
     * Returns: The OpenGL Object id.
     */
    public GLuint getId() {
        return id;
    }

    /**
     * Destroys the OpenGL Object in an implementation defined manner.
     */
    public abstract void destroy();

    /**
     * Generates the OpenGL Object id in an implementation defined manner.
     * 
     * Returns: The generated id.
     */
    protected abstract GLuint generateID();
}
